dxp-ux
Update billing address ( TMF -666 PATCH)
Request to update billing address
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id}Base URI Parameter
URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR) identifying the business unit. | Y |
| id | string | Billing Account Number. | Y |
Headers
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request Pattern: ^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64 | Y |
Request
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/billingAccount/21519514-21517998' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2gk' \
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'Content-Type: application/json' \
--data-raw '{
"relatedParty": [
{
"id": "15468766786",
"@type": "msisdn"
},
{
"@type": "channel",
"name": "Digital"
}
],
"contact": [
{
"contactMedium": [
{
"characteristic": {
"emailAddress": "test@test.com",
"street1": "123 Calle Juan Pablo Duarte",
"stateOrProvince": "PR",
"postCode": "0907",
"country": "US",
"city": "San Juan"
},
"@referredType": "billingAccount"
}
]
}
]
}'Definitions
| name | value (length) | description | required |
|---|---|---|---|
| relatedParty | array | related party array, refer below relatedParty table for more info | Y |
| relatedParty.id | string | unique identifier of related party | Y* |
| relatedParty.@type | string | type of the related party | Y* |
| relatedParty.name | string | name of the related party | Y* |
| contact | Array | Contact array | Y |
| contact.contactMedium | Array | details of contact medium | Y |
| contact.contactMedium.characterstic | Object | Characterstic Object | Y |
| contact.contactMedium.characterstic.stateOrProvince | string (70) | billing address state/province | Y* |
| contact.contactMedium.characterstic.city | string (70) | billing address city | Y* |
| contact.contactMedium.characterstic.emailAddress | string (50) | required on requestType is EMAIL | Y* |
| contact.contactMedium.characterstic.country | string (70) | billing address country | Y* |
| contact.contactMedium.characterstic.street1 | string (70) | billing address street | Y* |
| contact.contactMedium.characterstic.postCode | string (30) | billing address postal code | Y* |
| contact.contactMedium.@referredType | string | type of the account, status value like "billingAccount" | N |
relatedParty Values
| name | value (length) | description | required |
|---|---|---|---|
| msisdn | string (20) | related party array | Y |
| channel | string (20) | Source System information for tracking purpose, Possible values IVR, Digital | Y |
[ 200 ]
OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.
Response
{
"status": 200,
"description": "Email or Address change request received"
}Definitions
| name | value | description | required |
|---|---|---|---|
| status | Number | status code of the response | N |
| description | string | status description of the response | N |